Api.GetAxisByIndex method

Gets information from an axis.

Namespace: IntervalZero.KINGSTAR.OpcUa.Api

Assembly: IntervalZero.KINGSTAR.OpcUa.Api (in IntervalZero.KINGSTAR.OpcUa.Client.dll) Version: 4.4.0.0

Syntax

C#VB
public KsReturn<AxisDetails> GetAxisByIndex(
       int Index
)
Public Function GetAxisByIndex(
       Index As Integer
) As KsReturn(Of AxisDetails)

Parameters

Index

Type: int

The index of an axis. Indexes are zero based. Aliases affect this parameter.

Return value

Type: KsReturn <AxisDetails>

Returns a KsError code and an AxisDetails value.

Remarks

Gets the axis and its encoder resolution details. Used after the KINGSTAR Subsystem is started.

Usable EtherCAT states

ecatOP

Examples

C#
N/A

See also

Api Class

IntervalZero.KINGSTAR.OpcUa.Api Namespace